<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: async/op.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_ddc98e6e1a9e0f6adcacab8ac7c1f855.html">async</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">op.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="op_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="async__fwd_8hpp.html">flow/async/async_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="log_8hpp.html">flow/log/log.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="random_8hpp.html">flow/util/random.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1async.html">flow::async</a></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>{</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment">/* See `using Op =` in async_fwd.hpp for a key (in this context) doc header.</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> * @todo Maybe this stuff has grown big enough to deserve its own op_fwd.hpp? */</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"></span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment">/**</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * Simple, immutable `vector`-like sequence of N opaque async::Op objects, usually corresponding to N worker threads,</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * with typically used operations such as `[index]` and random `Op` selection.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> *</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * ### Thread safety ###</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * The object is immutable after construction; therefore each `*this` is safe for concurrent Op_list method calls.</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> *</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> *</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * ### Design rationale ###</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * This really only exists, at least originally, in service of Concurrent_task_loop::per_thread_ops() (which returns</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> * an Op_list nowadays).  An alternative approach would have been to move these simple facilities directly into</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> * Concurrent_task_loop superclass.  Historically that&#39;s how it started; there was a `vector&lt;Op&gt;` directly therein.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> * It worked fine but (1) complicated the otherwise pure interface Concurrent_task_loop into part-interface,</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> * part-logic-store-for-subclasses; and (2) increased the required cooperation between subclass and superclass (which is</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> * cute in finished code but harder to build on/maintain).  Hence, as experienced OO coders learn eventually,</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> * composition (where X is a member of Y) is more flexible and no more verbose than inheritance (where Y is a</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> * subclass of X); in both case the desired/achieved effect is to let Y leverage X&#39;s abilities.  Hence Op_list is a</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> * separate little class to be included as a member by whatever subclass of Concurrent_task_loop needs it.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> *</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * It is also a good sign that Op_list stands alone as a clean, reusable concept.  It may find other uses than</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * in Concurrent_task_loop::per_thread_ops().</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> */</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classflow_1_1async_1_1Op__list.html">   56</a></span><span class="keyword">class </span><a class="code hl_class" href="classflow_1_1async_1_1Op__list.html">Op_list</a> :</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1log_1_1Log__context.html">log::Log_context</a></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span>{</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"></span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment">   * Short-hand for function that that takes the target `Op`-list index and returns new async::Op whose copy</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment">   * is suitable as the permanent `Op` at that index.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment">   */</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classflow_1_1async_1_1Op__list.html#a9498a8f22aa6d9c6f8a22a65ed1289b0">   66</a></span>  <span class="keyword">using </span><a class="code hl_class" href="classflow_1_1Function.html">Create_op_func</a> = <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;<a class="code hl_typedef" href="namespaceflow_1_1async.html#a024042c64b7dc544a7a5587afa4b1949">Op</a> (<span class="keywordtype">size_t</span> target_op_idx)&gt;;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"></span> </div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment">   * Populates the async::Op list, which is immutable after this returns.  Caller may permanently</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">   * store `*this` with a `const` qualifier.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">   *</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">   *        Logger to which to log subsequently.</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">   * @param n_ops</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">   *        How many `Op`s will we permanently store?  The index range will therefore be</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment">   *        `[0, n_ops)` or `[0, n_ops - 1)`.  Must be at least 1, or `assert()` trips.</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment">   * @param create_op_func</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">   *        Caller&#39;s factory function that will generate the actual `n_ops` async::Op objects to store.</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">   *        The caller shall populate each `Op` it returns with a (small) value of whatever arbitrary type it wants.</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">   *        `create_op_func()` shall be called, in order, `n_ops` times synchronously, with index argument</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">   *        ranging fully through `[0, n_ops)`.  A copy of `Op create_op_func(idx)` is saved, and</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">   *        subsequently `(*this)[idx]` will return a reference to this permanently stored copy.</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment">   */</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classflow_1_1async_1_1Op__list.html#a3b9f96cfd38891bb254bf386c6e91df1">Op_list</a>(<a class="code hl_class" href="classflow_1_1log_1_1Logger.html">log::Logger</a>* logger_ptr, <span class="keywordtype">size_t</span> n_ops, <span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1Function.html">Create_op_func</a>&amp; create_op_func);</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"></span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment">   * Returns the number of async::Op stored in this Op_list.  The returned value is always the same.</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">   */</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1async_1_1Op__list.html#af57eb8d75c812add02418ef5b1dcafa6">size</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"></span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment">   * Returns reference to immutable async::Op at the given index in `[0, size())`.</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment">   * It is just like the `const` variety of `&quot;vector&lt;Op&gt;::operator[]&quot;`.</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment">   *</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment">   * @param idx</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">   *        Value in `[0, size())`.  `assert()` trips if out of range.</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment">   * @return See above.  Note the address stored in the returned *reference* is valid until destructor runs;</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment">   *         hence it&#39;s not necessary (though cheap) to copy the `Op`.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment">   */</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>  <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow_1_1async.html#a024042c64b7dc544a7a5587afa4b1949">Op</a>&amp; <a class="code hl_function" href="classflow_1_1async_1_1Op__list.html#a84e66e05d69e52adf455fede047cf265">operator[]</a>(<span class="keywordtype">size_t</span> idx) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"></span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment">   * Returns `(*this)[R]`, where we randomly select R as if by random_idx() and communicate it to the caller via</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment">   * optional out-arg.  Logs a TRACE message.</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment">   *</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment">   * @param chosen_idx</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment">   *        If not null, then a post-condition is that `*chosen_idx` has been set to the index of the returned</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment">   *        `Op`.</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment">   * @return See above.  Note the address stored in the returned *reference* is valid until destructor runs;</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment">   *         hence it&#39;s not necessary (though cheap) to copy the `Op`.</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">   */</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>  <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow_1_1async.html#a024042c64b7dc544a7a5587afa4b1949">Op</a>&amp; <a class="code hl_function" href="classflow_1_1async_1_1Op__list.html#a1aff00b9e7b67eb1bc4070533614dfc3">random_op</a>(<span class="keywordtype">size_t</span>* chosen_idx = 0) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"></span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment">   * Returns a randomly selected index from range [O, size()).</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">   */</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1async_1_1Op__list.html#ad0929efa574298c96c13845a6e020d7d">random_idx</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"></span> </div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment">   * Returns reference to immutable internally stored sequence of async::Op in order consistent with other</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment">   * methods of this class.</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment">   */</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>  <span class="keyword">const</span> std::vector&lt;Op&gt;&amp; <a class="code hl_function" href="classflow_1_1async_1_1Op__list.html#a70726f4c547b813687419f3c7cc9f977">ops_sequence</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span> </div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="keyword">private</span>:<span class="comment"></span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment">   * The payload of async::Op objects.  This is effectively `const` (immutable) after construction.  While `Op`</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment">   * copy is light-weight, the effective `const`ness we can nevertheless save a copy by always taking</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment">   * addresses like &amp;m_ops[i] when possible.</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment">   */</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"><a class="line" href="classflow_1_1async_1_1Op__list.html#abbbe77231b22d8db7bfaf9181e6028fe">  138</a></span>  std::vector&lt;Op&gt; <a class="code hl_variable" href="classflow_1_1async_1_1Op__list.html#abbbe77231b22d8db7bfaf9181e6028fe">m_ops</a>;</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"></span> </div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment">   * Random number facility for generating random indices in `[0, m_ops.size())`.  Thread-safe sans mutex.</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment">   *</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment">   * ### Implementation detail ###</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment">   * `m_rnd_op_idx()` is the only used operation, and it emits a pseudo-random number.  This can be viewed as</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment">   * as merely accessing an outside resource, conceptually, hence such operations should probably be `const`, as</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment">   * mutexes are for example.  So, as with a mutex, make it `mutable`.</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment">   */</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"><a class="line" href="classflow_1_1async_1_1Op__list.html#a55134b36cc93325a85131a8efc0843c2">  148</a></span>  <span class="keyword">mutable</span> <a class="code hl_class" href="classflow_1_1util_1_1Rnd__gen__uniform__range__mt.html">util::Rnd_gen_uniform_range_mt&lt;size_t&gt;</a> <a class="code hl_variable" href="classflow_1_1async_1_1Op__list.html#a55134b36cc93325a85131a8efc0843c2">m_rnd_op_idx</a>;</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>}; <span class="comment">// class Op_list</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span> </div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span>} <span class="comment">// namespace flow::async</span></div>
<div class="ttc" id="aasync__fwd_8hpp_html"><div class="ttname"><a href="async__fwd_8hpp.html">async_fwd.hpp</a></div></div>
<div class="ttc" id="aclassflow_1_1Function_html"><div class="ttname"><a href="classflow_1_1Function.html">flow::Function</a></div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00512">common.hpp:512</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Op__list_html"><div class="ttname"><a href="classflow_1_1async_1_1Op__list.html">flow::async::Op_list</a></div><div class="ttdoc">Simple, immutable vector-like sequence of N opaque async::Op objects, usually corresponding to N work...</div><div class="ttdef"><b>Definition:</b> <a href="op_8hpp_source.html#l00056">op.hpp:58</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Op__list_html_a1aff00b9e7b67eb1bc4070533614dfc3"><div class="ttname"><a href="classflow_1_1async_1_1Op__list.html#a1aff00b9e7b67eb1bc4070533614dfc3">flow::async::Op_list::random_op</a></div><div class="ttdeci">const Op &amp; random_op(size_t *chosen_idx=0) const</div><div class="ttdoc">Returns (*this)[R], where we randomly select R as if by random_idx() and communicate it to the caller...</div><div class="ttdef"><b>Definition:</b> <a href="op_8cpp_source.html#l00051">op.cpp:51</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Op__list_html_a3b9f96cfd38891bb254bf386c6e91df1"><div class="ttname"><a href="classflow_1_1async_1_1Op__list.html#a3b9f96cfd38891bb254bf386c6e91df1">flow::async::Op_list::Op_list</a></div><div class="ttdeci">Op_list(log::Logger *logger_ptr, size_t n_ops, const Create_op_func &amp;create_op_func)</div><div class="ttdoc">Populates the async::Op list, which is immutable after this returns.</div><div class="ttdef"><b>Definition:</b> <a href="op_8cpp_source.html#l00026">op.cpp:26</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Op__list_html_a55134b36cc93325a85131a8efc0843c2"><div class="ttname"><a href="classflow_1_1async_1_1Op__list.html#a55134b36cc93325a85131a8efc0843c2">flow::async::Op_list::m_rnd_op_idx</a></div><div class="ttdeci">util::Rnd_gen_uniform_range_mt&lt; size_t &gt; m_rnd_op_idx</div><div class="ttdoc">Random number facility for generating random indices in [0, m_ops.size()).</div><div class="ttdef"><b>Definition:</b> <a href="op_8hpp_source.html#l00148">op.hpp:148</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Op__list_html_a70726f4c547b813687419f3c7cc9f977"><div class="ttname"><a href="classflow_1_1async_1_1Op__list.html#a70726f4c547b813687419f3c7cc9f977">flow::async::Op_list::ops_sequence</a></div><div class="ttdeci">const std::vector&lt; Op &gt; &amp; ops_sequence() const</div><div class="ttdoc">Returns reference to immutable internally stored sequence of async::Op in order consistent with other...</div><div class="ttdef"><b>Definition:</b> <a href="op_8cpp_source.html#l00070">op.cpp:70</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Op__list_html_a84e66e05d69e52adf455fede047cf265"><div class="ttname"><a href="classflow_1_1async_1_1Op__list.html#a84e66e05d69e52adf455fede047cf265">flow::async::Op_list::operator[]</a></div><div class="ttdeci">const Op &amp; operator[](size_t idx) const</div><div class="ttdoc">Returns reference to immutable async::Op at the given index in [0, size()).</div><div class="ttdef"><b>Definition:</b> <a href="op_8cpp_source.html#l00046">op.cpp:46</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Op__list_html_abbbe77231b22d8db7bfaf9181e6028fe"><div class="ttname"><a href="classflow_1_1async_1_1Op__list.html#abbbe77231b22d8db7bfaf9181e6028fe">flow::async::Op_list::m_ops</a></div><div class="ttdeci">std::vector&lt; Op &gt; m_ops</div><div class="ttdoc">The payload of async::Op objects.</div><div class="ttdef"><b>Definition:</b> <a href="op_8hpp_source.html#l00138">op.hpp:138</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Op__list_html_ad0929efa574298c96c13845a6e020d7d"><div class="ttname"><a href="classflow_1_1async_1_1Op__list.html#ad0929efa574298c96c13845a6e020d7d">flow::async::Op_list::random_idx</a></div><div class="ttdeci">size_t random_idx() const</div><div class="ttdoc">Returns a randomly selected index from range [O, size()).</div><div class="ttdef"><b>Definition:</b> <a href="op_8cpp_source.html#l00065">op.cpp:65</a></div></div>
<div class="ttc" id="aclassflow_1_1async_1_1Op__list_html_af57eb8d75c812add02418ef5b1dcafa6"><div class="ttname"><a href="classflow_1_1async_1_1Op__list.html#af57eb8d75c812add02418ef5b1dcafa6">flow::async::Op_list::size</a></div><div class="ttdeci">size_t size() const</div><div class="ttdoc">Returns the number of async::Op stored in this Op_list.</div><div class="ttdef"><b>Definition:</b> <a href="op_8cpp_source.html#l00041">op.cpp:41</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Log__context_html"><div class="ttname"><a href="classflow_1_1log_1_1Log__context.html">flow::log::Log_context</a></div><div class="ttdoc">Convenience class that simply stores a Logger and/or Component passed into a constructor; and returns...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01609">log.hpp:1610</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Logger_html"><div class="ttname"><a href="classflow_1_1log_1_1Logger.html">flow::log::Logger</a></div><div class="ttdoc">Interface that the user should implement, passing the implementing Logger into logging classes (Flow'...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01280">log.hpp:1284</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Rnd__gen__uniform__range__mt_html"><div class="ttname"><a href="classflow_1_1util_1_1Rnd__gen__uniform__range__mt.html">flow::util::Rnd_gen_uniform_range_mt</a></div><div class="ttdoc">Identical to Rnd_gen_uniform_range but safe for concurrent RNG given a single object.</div><div class="ttdef"><b>Definition:</b> <a href="random_8hpp_source.html#l00156">random.hpp:158</a></div></div>
<div class="ttc" id="alog_8hpp_html"><div class="ttname"><a href="log_8hpp.html">log.hpp</a></div></div>
<div class="ttc" id="anamespaceflow_1_1async_html"><div class="ttname"><a href="namespaceflow_1_1async.html">flow::async</a></div><div class="ttdoc">Flow module containing tools enabling multi-threaded event loops operating under the asynchronous-tas...</div><div class="ttdef"><b>Definition:</b> <a href="async__fwd_8hpp_source.html#l00074">async_fwd.hpp:75</a></div></div>
<div class="ttc" id="anamespaceflow_1_1async_html_a024042c64b7dc544a7a5587afa4b1949"><div class="ttname"><a href="namespaceflow_1_1async.html#a024042c64b7dc544a7a5587afa4b1949">flow::async::Op</a></div><div class="ttdeci">boost::any Op</div><div class="ttdoc">An object of this opaque type represents a collection of 1 or more async::Task, past or future,...</div><div class="ttdef"><b>Definition:</b> <a href="async__fwd_8hpp_source.html#l00153">async_fwd.hpp:153</a></div></div>
<div class="ttc" id="arandom_8hpp_html"><div class="ttname"><a href="random_8hpp.html">random.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
